Skip to content

Docs: Document docs-writing.md#3569

Closed
akamabu wants to merge 1 commit into
triggerdotdev:mainfrom
akamabu:round3-27c6f7
Closed

Docs: Document docs-writing.md#3569
akamabu wants to merge 1 commit into
triggerdotdev:mainfrom
akamabu:round3-27c6f7

Conversation

@akamabu
Copy link
Copy Markdown

@akamabu akamabu commented May 13, 2026

Documents .claude/rules/docs-writing.md module purpose and public usage context

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 13, 2026

⚠️ No Changeset found

Latest commit: ec3c58c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: bf1c8df7-9522-4077-aa70-3133b864d5b5

📥 Commits

Reviewing files that changed from the base of the PR and between 6b0e78f and ec3c58c.

📒 Files selected for processing (1)
  • .claude/rules/docs-writing.md

Walkthrough

This PR introduces a new AI rules file (.claude/rules/docs-writing.md) that defines documentation writing conventions for the project. The file specifies that documentation must use Mintlify MDX format with required frontmatter fields (title, description, icon), requires updates to docs.json after page creation, mandates use of Mintlify components for callouts and code examples, restricts Trigger SDK imports to @trigger.dev/sdk only, and establishes formatting conventions including short paragraphs with headers and relative link usage.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

Hi @akamabu, thanks for your interest in contributing!

This project requires that pull request authors are vouched, and you are not in the list of vouched users.

This PR will be closed automatically. See https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md for more details.

@github-actions github-actions Bot closed this May 13, 2026
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

View 1 additional finding in Devin Review.

Open in Devin Review

@@ -1,3 +1,4 @@
<!-- Documents .claude/rules/docs-writing.md module purpose and public usage context -->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 HTML comment before YAML frontmatter breaks path-based rule filtering

The added HTML comment <!-- Documents ... --> on line 1 precedes the --- frontmatter delimiter. YAML frontmatter parsers require the opening --- to be on the very first line of the file. With content before it, the frontmatter block (paths: ["docs/**"]) will not be recognized, so Claude Code won't know this rule is scoped to docs/** files. Depending on the parser, the rule will either be ignored entirely or applied globally to all files instead of only docs. Every other rule file in .claude/rules/ correctly starts with --- on line 1.

Suggested change
<!-- Documents .claude/rules/docs-writing.md module purpose and public usage context -->
---
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant